home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / u_man / cat3 / Tk / pack.z / pack
Encoding:
Text File  |  1998-10-30  |  16.0 KB  |  331 lines
  1.  
  2.  
  3.  
  4. ppppaaaacccckkkk((((3333TTTTkkkk))))                                                            ppppaaaacccckkkk((((3333TTTTkkkk))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      pack - Geometry manager that packs around edges of cavity
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ppppaaaacccckkkk _o_p_t_i_o_n _a_r_g ?_a_r_g ...?
  13.  
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      The ppppaaaacccckkkk command is used to communicate with the packer, a geometry
  17.      manager that arranges the children of a parent by packing them in order
  18.      around the edges of the parent.  The ppppaaaacccckkkk command can have any of several
  19.      forms, depending on the _o_p_t_i_o_n argument:
  20.  
  21.      ppppaaaacccckkkk _s_l_a_v_e ?_s_l_a_v_e ...? ?_o_p_t_i_o_n_s?
  22.           If the first argument to ppppaaaacccckkkk is a window name (any value starting
  23.           with ``.''), then the command is processed in the same way as ppppaaaacccckkkk
  24.           ccccoooonnnnffffiiiigggguuuurrrreeee.
  25.  
  26.      ppppaaaacccckkkk ccccoooonnnnffffiiiigggguuuurrrreeee _s_l_a_v_e ?_s_l_a_v_e ...? ?_o_p_t_i_o_n_s?
  27.           The arguments consist of the names of one or more slave windows
  28.           followed by pairs of arguments that specify how to manage the
  29.           slaves.  See ``THE PACKER ALGORITHM'' below for details on how the
  30.           options are used by the packer.  The following options are
  31.           supported:
  32.  
  33.           ----aaaafffftttteeeerrrr _o_t_h_e_r
  34.                _O_t_h_e_r must the name of another window.  Use its master as the
  35.                master for the slaves, and insert the slaves just after _o_t_h_e_r
  36.                in the packing order.
  37.  
  38.           ----aaaannnncccchhhhoooorrrr _a_n_c_h_o_r
  39.                _A_n_c_h_o_r must be a valid anchor position such as nnnn or sssswwww; it
  40.                specifies where to position each slave in its parcel.  Defaults
  41.                to cccceeeennnntttteeeerrrr.
  42.  
  43.           ----bbbbeeeeffffoooorrrreeee _o_t_h_e_r
  44.                _O_t_h_e_r must the name of another window.  Use its master as the
  45.                master for the slaves, and insert the slaves just before _o_t_h_e_r
  46.                in the packing order.
  47.  
  48.           ----eeeexxxxppppaaaannnndddd _b_o_o_l_e_a_n
  49.                Specifies whether the slaves should be expanded to consume
  50.                extra space in their master.  _B_o_o_l_e_a_n may have any proper
  51.                boolean value, such as 1111 or nnnnoooo.  Defaults to 0.
  52.  
  53.           ----ffffiiiillllllll _s_t_y_l_e
  54.                If a slave's parcel is larger than its requested dimensions,
  55.                this option may be used to stretch the slave.  _S_t_y_l_e must have
  56.                one of the following values:
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ppppaaaacccckkkk((((3333TTTTkkkk))))                                                            ppppaaaacccckkkk((((3333TTTTkkkk))))
  71.  
  72.  
  73.  
  74.                nnnnoooonnnneeee Give the slave its requested dimensions plus any internal
  75.                     padding requested with ----iiiippppaaaaddddxxxx or ----iiiippppaaaaddddyyyy.  This is the
  76.                     default.
  77.  
  78.                xxxx    Stretch the slave horizontally to fill the entire width of
  79.                     its parcel (except leave external padding as specified by
  80.                     ----ppppaaaaddddxxxx).
  81.  
  82.                yyyy    Stretch the slave vertically to fill the entire height of
  83.                     its parcel (except leave external padding as specified by
  84.                     ----ppppaaaaddddyyyy).
  85.  
  86.                bbbbooootttthhhh Stretch the slave both horizontally and vertically.
  87.  
  88.           ----iiiinnnn _o_t_h_e_r
  89.                Insert the slave(s) at the end of the packing order for the
  90.                master window given by _o_t_h_e_r.
  91.  
  92.           ----iiiippppaaaaddddxxxx _a_m_o_u_n_t
  93.                _A_m_o_u_n_t specifies how much horizontal internal padding to leave
  94.                on each side of the slave(s).  _A_m_o_u_n_t must be a valid screen
  95.                distance, such as 2222 or ....5555cccc.  It defaults to 0.
  96.  
  97.           ----iiiippppaaaaddddyyyy _a_m_o_u_n_t
  98.                _A_m_o_u_n_t specifies how much vertical internal padding to leave on
  99.                each side of the slave(s).  _A_m_o_u_n_t  defaults to 0.
  100.  
  101.           ----ppppaaaaddddxxxx _a_m_o_u_n_t
  102.                _A_m_o_u_n_t specifies how much horizontal external padding to leave
  103.                on each side of the slave(s).  _A_m_o_u_n_t defaults to 0.
  104.  
  105.           ----ppppaaaaddddyyyy _a_m_o_u_n_t
  106.                _A_m_o_u_n_t specifies how much vertical external padding to leave on
  107.                each side of the slave(s).  _A_m_o_u_n_t defaults to 0.
  108.  
  109.           ----ssssiiiiddddeeee _s_i_d_e
  110.                Specifies which side of the master the slave(s) will be packed
  111.                against.  Must be lllleeeefffftttt, rrrriiiigggghhhhtttt, ttttoooopppp, or bbbboooottttttttoooommmm.  Defaults to
  112.                ttttoooopppp.
  113.  
  114.           If no ----iiiinnnn, ----aaaafffftttteeeerrrr or ----bbbbeeeeffffoooorrrreeee option is specified then each of the
  115.           slaves will be inserted at the end of the packing list for its
  116.           parent unless it is already managed by the packer (in which case it
  117.           will be left where it is).  If one of these options is specified
  118.           then all the slaves will be inserted at the specified point.  If any
  119.           of the slaves are already managed by the geometry manager then any
  120.           unspecified options for them retain their previous values rather
  121.           than receiving default values.
  122.  
  123.      ppppaaaacccckkkk ffffoooorrrrggggeeeetttt _s_l_a_v_e ?_s_l_a_v_e ...?
  124.           Removes each of the _s_l_a_v_es from the packing order for its master and
  125.           unmaps their windows.  The slaves will no longer be managed by the
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ppppaaaacccckkkk((((3333TTTTkkkk))))                                                            ppppaaaacccckkkk((((3333TTTTkkkk))))
  137.  
  138.  
  139.  
  140.           packer.
  141.  
  142.      ppppaaaacccckkkk iiiinnnnffffoooo _s_l_a_v_e
  143.           Returns a list whose elements are the current configuration state of|
  144.           the slave given by _s_l_a_v_e in the same option-value form that might be|
  145.           specified to ppppaaaacccckkkk ccccoooonnnnffffiiiigggguuuurrrreeee.  The first two elements of the list are|
  146.           ``----iiiinnnn _m_a_s_t_e_r'' where _m_a_s_t_e_r is the slave's master.
  147.  
  148.      ppppaaaacccckkkk pppprrrrooooppppaaaaggggaaaatttteeee _m_a_s_t_e_r ?_b_o_o_l_e_a_n?
  149.           If _b_o_o_l_e_a_n has a true boolean value such as 1111 or oooonnnn then propagation
  150.           is enabled for _m_a_s_t_e_r, which must be a window name (see ``GEOMETRY
  151.           PROPAGATION'' below).  If _b_o_o_l_e_a_n has a false boolean value then
  152.           propagation is disabled for _m_a_s_t_e_r.  In either of these cases an
  153.           empty string is returned.  If _b_o_o_l_e_a_n is omitted then the command
  154.           returns 0000 or 1111 to indicate whether propagation is currently enabled
  155.           for _m_a_s_t_e_r.  Propagation is enabled by default.
  156.  
  157.      ppppaaaacccckkkk ssssllllaaaavvvveeeessss _m_a_s_t_e_r
  158.           Returns a list of all of the slaves in the packing order for _m_a_s_t_e_r.
  159.           The order of the slaves in the list is the same as their order in
  160.           the packing order.  If _m_a_s_t_e_r has no slaves then an empty string is
  161.           returned.
  162.  
  163.  
  164. TTTTHHHHEEEE PPPPAAAACCCCKKKKEEEERRRR AAAALLLLGGGGOOOORRRRIIIITTTTHHHHMMMM
  165.      For each master the packer maintains an ordered list of slaves called the
  166.      _p_a_c_k_i_n_g _l_i_s_t.  The ----iiiinnnn, ----aaaafffftttteeeerrrr, and ----bbbbeeeeffffoooorrrreeee configuration options are
  167.      used to specify the master for each slave and the slave's position in the
  168.      packing list.  If none of these options is given for a slave then the
  169.      slave is added to the end of the packing list for its parent.
  170.  
  171.      The packer arranges the slaves for a master by scanning the packing list
  172.      in order.  At the time it processes each slave, a rectangular area within
  173.      the master is still unallocated.  This area is called the _c_a_v_i_t_y;  for
  174.      the first slave it is the entire area of the master.
  175.  
  176.      For each slave the packer carries out the following steps:
  177.  
  178.      [1]  The packer allocates a rectangular _p_a_r_c_e_l for the slave along the
  179.           side of the cavity given by the slave's ----ssssiiiiddddeeee option.  If the side
  180.           is top or bottom then the width of the parcel is the width of the
  181.           cavity and its height is the requested height of the slave plus the
  182.           ----iiiippppaaaaddddyyyy and ----ppppaaaaddddyyyy options.  For the left or right side the height of
  183.           the parcel is the height of the cavity and the width is the
  184.           requested width of the slave plus the ----iiiippppaaaaddddxxxx and ----ppppaaaaddddxxxx options.  The
  185.           parcel may be enlarged further because of the ----eeeexxxxppppaaaannnndddd option (see
  186.           ``EXPANSION'' below)
  187.  
  188.      [2]  The packer chooses the dimensions of the slave.  The width will
  189.           normally be the slave's requested width plus twice its ----iiiippppaaaaddddxxxx option
  190.           and the height will normally be the slave's requested height plus
  191.           twice its ----iiiippppaaaaddddyyyy option.  However, if the ----ffffiiiillllllll option is xxxx or bbbbooootttthhhh
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ppppaaaacccckkkk((((3333TTTTkkkk))))                                                            ppppaaaacccckkkk((((3333TTTTkkkk))))
  203.  
  204.  
  205.  
  206.           then the width of the slave is expanded to fill the width of the
  207.           parcel, minus twice the ----ppppaaaaddddxxxx option.  If the ----ffffiiiillllllll option is yyyy or
  208.           bbbbooootttthhhh then the height of the slave is expanded to fill the width of
  209.           the parcel, minus twice the ----ppppaaaaddddyyyy option.
  210.  
  211.      [3]  The packer positions the slave over its parcel.  If the slave is
  212.           smaller than the parcel then the ----aaaannnncccchhhhoooorrrr option determines where in
  213.           the parcel the slave will be placed.  If ----ppppaaaaddddxxxx or ----ppppaaaaddddyyyy is non-zero,
  214.           then the given amount of external padding will always be left
  215.           between the slave and the edges of the parcel.
  216.  
  217.      Once a given slave has been packed, the area of its parcel is subtracted
  218.      from the cavity, leaving a smaller rectangular cavity for the next slave.
  219.      If a slave doesn't use all of its parcel, the unused space in the parcel
  220.      will not be used by subsequent slaves.  If the cavity should become too
  221.      small to meet the needs of a slave then the slave will be given whatever
  222.      space is left in the cavity.  If the cavity shrinks to zero size, then
  223.      all remaining slaves on the packing list will be unmapped from the screen
  224.      until the master window becomes large enough to hold them again.
  225.  
  226.  
  227. EEEEXXXXPPPPAAAANNNNSSSSIIIIOOOONNNN
  228.      If a master window is so large that there will be extra space left over
  229.      after all of its slaves have been packed, then the extra space is
  230.      distributed uniformly among all of the slaves for which the ----eeeexxxxppppaaaannnndddd
  231.      option is set.  Extra horizontal space is distributed among the
  232.      expandable slaves whose ----ssssiiiiddddeeee is lllleeeefffftttt or rrrriiiigggghhhhtttt, and extra vertical space
  233.      is distributed among the expandable slaves whose ----ssssiiiiddddeeee is ttttoooopppp or bbbboooottttttttoooommmm.
  234.  
  235.  
  236. GGGGEEEEOOOOMMMMEEEETTTTRRRRYYYY PPPPRRRROOOOPPPPAAAAGGGGAAAATTTTIIIIOOOONNNN
  237.      The packer normally computes how large a master must be to just exactly
  238.      meet the needs of its slaves, and it sets the requested width and height
  239.      of the master to these dimensions.  This causes geometry information to
  240.      propagate up through a window hierarchy to a top-level window so that the
  241.      entire sub-tree sizes itself to fit the needs of the leaf windows.
  242.      However, the ppppaaaacccckkkk pppprrrrooooppppaaaaggggaaaatttteeee command may be used to turn off propagation
  243.      for one or more masters.  If propagation is disabled then the packer will
  244.      not set the requested width and height of the packer.  This may be useful
  245.      if, for example, you wish for a master window to have a fixed size that
  246.      you specify.
  247.  
  248.  
  249. RRRREEEESSSSTTTTRRRRIIIICCCCTTTTIIIIOOOONNNNSSSS OOOONNNN MMMMAAAASSSSTTTTEEEERRRR WWWWIIIINNNNDDDDOOOOWWWWSSSS
  250.      The master for each slave must either be the slave's parent (the default)
  251.      or a descendant of the slave's parent.  This restriction is necessary to
  252.      guarantee that the slave can be placed over any part of its master that
  253.      is visible without danger of the slave being clipped by its parent.
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. ppppaaaacccckkkk((((3333TTTTkkkk))))                                                            ppppaaaacccckkkk((((3333TTTTkkkk))))
  269.  
  270.  
  271.  
  272. PPPPAAAACCCCKKKKIIIINNNNGGGG OOOORRRRDDDDEEEERRRR
  273.      If the master for a slave is not its parent then you must make sure that
  274.      the slave is higher in the stacking order than the master.  Otherwise the
  275.      master will obscure the slave and it will appear as if the slave hasn't
  276.      been packed correctly.  The easiest way to make sure the slave is higher
  277.      than the master is to create the master window first:  the most recently
  278.      created window will be highest in the stacking order.  Or, you can use
  279.      the rrrraaaaiiiisssseeee and lllloooowwwweeeerrrr commands to change the stacking order of either the
  280.      master or the slave.
  281.  
  282.  
  283. KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  284.      geometry manager, location, packer, parcel, propagation, size
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.